Saltar al contenido principal
GET
/
brands
/
{id}
Obtener marca
curl --request GET \
  --url https://api.example.com/brands/{id}
{
  "data": {
    "id": "0001",
    "uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Burger Co.",
    "status": "ACTIVE",
    "cms_template_id": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
    "cms": {
      "id": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
      "name": "Landing de marca",
      "entity": "BRANDS",
      "status": "ACTIVE",
      "fields": [
        {
          "name": "tagline",
          "type": "TEXT",
          "label": { "es_ec": "Eslogan" },
          "required": false,
          "value": "A la parrilla desde 1987"
        }
      ]
    }
  }
}
Devuelve una marca por su id externo. Usa este endpoint después de que el cliente seleccione una marca para cargar su nombre, estado y contenido CMS en el storefront.
Requiere un access token de Fire spark obtenido mediante intercambio de token.

​
Parámetros de ruta

ParámetroRequeridoDescripción
idSíIdentificador externo de la marca. Solo alfanuméricos, _ y -. 1–64 caracteres.

​
Solicitud

curl "https://firespark.vercel.app/api/storefront/v1/brands/0001" \
  -H "Authorization: Bearer ACCESS_TOKEN"

​
Respuesta

La respuesta envuelve un objeto marca en data. La estructura coincide con listar marcas. 
{
  "data": {
    "id": "0001",
    "uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Burger Co.",
    "status": "ACTIVE",
    "cms_template_id": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
    "cms": {
      "id": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
      "name": "Landing de marca",
      "entity": "BRANDS",
      "status": "ACTIVE",
      "fields": [
        {
          "name": "tagline",
          "type": "TEXT",
          "label": { "es_ec": "Eslogan" },
          "required": false,
          "value": "A la parrilla desde 1987"
        }
      ]
    }
  }
}

​
Campos de marca

Consulta listar marcas para el esquema completo, incluyendo cms_template_id y cms.
Envía el id de la marca en el header x-brand-id en listar tiendas y listar canales para limitar los resultados a esa marca.

​
Respuestas de error

EstadoDescripción
401Access token ausente o inválido.
403El token no tiene acceso a esta marca.
404No existe una marca con el id indicado.